Skip to content

Issue template for notebook updates#428

Merged
itcarroll merged 11 commits into
mainfrom
issue-template-update-notebook
Apr 9, 2026
Merged

Issue template for notebook updates#428
itcarroll merged 11 commits into
mainfrom
issue-template-update-notebook

Conversation

@ateucher

@ateucher ateucher commented Apr 9, 2026

Copy link
Copy Markdown
Member

An issue template for proposing notebook updates based on #425 by @mikala-nsidc. A companion to the "remove notebook" template merged in #423

@ateucher ateucher requested review from Copilot and mikala-nsidc April 9, 2026 16:41
Copilot AI reviewed Apr 9, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new GitHub Issue Form template to propose updates to cookbook notebook/page content (companion to the previously added “remove notebook” template).

Changes:

  • Introduces an “Update notebook” issue template with fields for target content, what’s out of date/missing, recommended updates, and context.
  • Adds a “Decision” checkbox section to record the outcome before opening a PR or closing the issue.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/ISSUE_TEMPLATE/update-notebook.yml Outdated
@ateucher ateucher mentioned this pull request Apr 9, 2026
Open
3 tasks
@github-actions

github-actions Bot commented Apr 9, 2026 •
edited
Loading

Copy link
Copy Markdown

🚀 Deployed on https://deploy-preview-428--openscapes-org-preview.netlify.app

@github-actions github-actions Bot temporarily deployed to pull request April 9, 2026 16:45 Inactive
@ateucher
Update .github/ISSUE_TEMPLATE/update-notebook.yml
6396d55 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@github-actions github-actions Bot temporarily deployed to pull request April 9, 2026 16:49 Inactive
@itcarroll

itcarroll commented Apr 9, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

What do you think about changing the "Decision" section to something more informational? I'm doubtful the checkboxes will be successfully used. Checkboxes also aren't an "either-or" data field, possibly leading to some confusion with "to-do" checkboxes. How about this markdown type section as an alternative:

For the update template:

  - type: markdown
    attributes:
      value: |
        ## Final resolution
        After discussion, how this feedback is addressed will show up in how the issue is resolved.
        1. Closed as completed: Merging a PR to update this notebook automatically closes this issue.
        2. Closed as won't fix: The author or maintainer closes this issue manually if no changes are necessary.
        3. Closed as duplicate: The author or maintainer closes this issue after linking a similar issue.

For the remove template:

  - type: markdown
    attributes:
      value: |
        ## Final resolution
        After discussion, how this feedback is addressed will show up in how the issue is resolved.
        1. Closed as completed: Merging a PR to remove this notebook automatically closes this issue.
        2. Closed as won't fix: The author or maintainer closes this issue manually if no changes are necessary.
        3. Closed as duplicate: The author or maintainer closes this issue after linking a new issue from the "Update notebook" template.

Not sure about exact wording yet, so I didn't want to put this in as a code suggestion.

@ateucher

ateucher commented Apr 9, 2026

Copy link
Copy Markdown
Member Author

I like that idea @itcarroll, it's a bit clearer. Do you think we should link to the other issue templates (i.e., if someone opens an issue to remove a notebook, but it becomes clear that just an update would be better they should open an "update" issue?

@itcarroll itcarroll self-requested a review April 9, 2026 18:48
@github-actions github-actions Bot temporarily deployed to pull request April 9, 2026 19:03 Inactive
itcarroll
itcarroll approved these changes Apr 9, 2026
View reviewed changes

@itcarroll itcarroll left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've gone ahead with some additional enhancements beyond the scope of the original issue for consistency.

I think we won't be able to see if this is all "working" until its merged to main. I'm available to rapidly take up fixes as needed.

@github-actions github-actions Bot temporarily deployed to pull request April 9, 2026 19:07 Inactive
itcarroll
itcarroll reviewed Apr 9, 2026
View reviewed changes
Comment thread .github/ISSUE_TEMPLATE/add-notebook.yml Outdated
@github-actions github-actions Bot temporarily deployed to pull request April 9, 2026 19:14 Inactive
ateucher
ateucher commented Apr 9, 2026
View reviewed changes

@ateucher ateucher left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @itcarroll great changes! I had a two small comments, otherwise I think you can merge this. I can't approve since I'm the original PR author

Comment thread .github/ISSUE_TEMPLATE/add-notebook.yml
Comment thread .github/ISSUE_TEMPLATE/update-notebook.yml Outdated
@itcarroll itcarroll merged commit a1e6c08 into main Apr 9, 2026
3 checks passed
@itcarroll itcarroll deleted the issue-template-update-notebook branch April 9, 2026 20:09
@github-actions github-actions Bot temporarily deployed to pull request April 9, 2026 20:10 Inactive
@itcarroll itcarroll restored the issue-template-update-notebook branch April 9, 2026 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@itcarroll itcarroll itcarroll approved these changes
Copilot code review Copilot Copilot left review comments
@mikala-nsidc mikala-nsidc Awaiting requested review from mikala-nsidc

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ateucher @itcarroll